Interface RemoteNetwork

All Superinterfaces:
Device, IPCObject
All Known Implementing Classes:
RemoteNetworkImpl

public interface RemoteNetwork extends Device
Information provided by the PKI file:

    \class RemoteNetwork
    
    \brief RemoteNetwork handles and manipulates Multiuser remote networks.
    
    \example multiUserManager().getRemoteNetworkAt(0)
    
Author:
Auto-generated
  • Method Details

    • connect

      boolean connect(String peerAddress, int peerPort, String userName, String password)
      Information provided by the PKI file:
      
          \brief Makes a Multiuser connection to a peer remote network.
          
          \param peerAddress, the peer address of the peer remote network.
          \param peerPort, the peer port number of the peer remote network.
          \param userName, the peer network name of the peer remote network.
          \param password, the peer password of the peer remote network.
          
          \return bool, true if successful, otherwise false.
          
              
      Parameters:
      peerAddress - Takes in a parameter of peerAddress
      peerPort - Takes in a parameter of peerPort
      userName - Takes in a parameter of userName
      password - Takes in a parameter of password
      Returns:
      boolean Returns a boolean
    • disconnect

      void disconnect()
      Information provided by the PKI file:
      
          \brief Disconnects the Multiuser connection.
          
              
    • isConnected

      boolean isConnected()
      Information provided by the PKI file:
      
          \brief Returns true if the remote network is connected, otherwise false.
          
          \return bool, true if the remote network is connected, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • setPeerAddress

      void setPeerAddress(String address)
      Information provided by the PKI file:
      
          \brief Sets the peer address for the outgoing connection.
          
          \param address, the peer address for the outgoing connection.
          
              
      Parameters:
      address - Takes in a parameter of address
    • getPeerAddress

      String getPeerAddress()
      Information provided by the PKI file:
      
          \brief Returns the peer address for the outgoing connection.
          
          \return QString, the peer address for the outgoing connection.
          
              
      Returns:
      String Returns a String
    • setPortNumber

      void setPortNumber(int port)
      Information provided by the PKI file:
      
          \brief Sets the peer port number for the outgoing connection.
          
          \param port, the peer port number for the outgoing connection.
          
              
      Parameters:
      port - Takes in a parameter of port
    • getPortNumber

      int getPortNumber()
      Information provided by the PKI file:
      
          \brief Returns the peer port number for the outgoing connection.
          
          \return int, the peer port number for the outgoing connection.
          
              
      Returns:
      int Returns a int
    • setConnectAsUserName

      void setConnectAsUserName(String username)
      Information provided by the PKI file:
      
          \brief Sets the user name entered when making the outgoing connection.
          
          \param username, the username to use.
          
              
      Parameters:
      username - Takes in a parameter of username
    • getConnectAsUserName

      String getConnectAsUserName()
      Information provided by the PKI file:
      
          \brief Returns the peer network name for the outgoing connection.
          
          \return QString, the peer network name for the outgoing connection.
          
              
      Returns:
      String Returns a String
    • setPassword

      void setPassword(String password)
      Information provided by the PKI file:
      
          \brief Sets the peer password for the outgoing connection.
          
          \param password, the peer password for the outgoing connection.
          
              
      Parameters:
      password - Takes in a parameter of password
    • getPassword

      String getPassword()
      Information provided by the PKI file:
      
          \brief Returns the peer password for the outgoing connection.
          
          \return QString, the peer password for the outgoing connection.
          
              
      Returns:
      String Returns a String
    • setMode

      void setMode(boolean bOutgoing)
      Information provided by the PKI file:
      
          \brief Sets the Multiuser connection type to outgoing or incoming.
          
          \param bOutgoing, true for outgoing connection, false for incoming connection.
          
              
      Parameters:
      bOutgoing - Takes in a parameter of bOutgoing
    • isOutgoing

      boolean isOutgoing()
      Information provided by the PKI file:
      
          \brief Returns true if the remote network is set to outgoing connection, false if incoming connection.
          
          \return bool, true if the remote network is set to outgoing connection, false if incoming connection.
          
              
      Returns:
      boolean Returns a boolean